Store adapter — Spark Pay¶

The adapter object contains properties for connecting to the Spark Pay API.

Parent object: a store with property "platform" : "spark_pay"

Required properties¶

The following adapter properties are required for Spark Pay stores.

`access_token`¶

Property	`access_token`
Name	Spark Pay API Access Token
Data type	string
Required?	Yes

`order_completed_status_id`¶

Property	`order_completed_status_id`
Name	Order Completed Status
Description	Status to complete an order
Data type	string
Required?	Yes

`url`¶

Property	`url`
Name	Spark Pay Store URL
Data type	string
Example	`"https://store.mysparkpay.com"`
Required?	Yes

Optional properties¶

The following adapter properties are optional for Spark Pay stores.

`order_status_ids`¶

Property	`order_status_ids`
Name	Order Import Statuses
Description	One or more statuses. Only orders with at least one of these statuses are imported. If `null`, all orders are imported, regardless of status
Data type	array of strings
Default	`null`
Example	`[ "status1", "status2" ]`

Example¶

Example: create a new Spark Pay store

cURL

curl -X POST \
    -H "Authorization: Bearer $JWT_TOKEN" \
    -H "Content-Type: application/json" \
    https://api.getdropstream.com/stores \
    -d @- <<EOF
{ "customer_id": "3775",
  "name": "Your Spark Pay Store",
  "platform": "spark_pay",
  "adapter": {
    "url": "https://www.example.com",
    "access_token": "abc123",
    "order_completed_status_id": "abc123",
    "order_status_ids": [ "status1", "status2" ]
  }
}
EOF

For details about this request type, see: Create a new store.

Store adapter — Spark Pay¶

Required properties¶

access_token¶

order_completed_status_id¶

url¶